Skip to content

Docs use dynamic python version from pypi#69

Merged
cpaniaguam merged 2 commits intomainfrom
docs-use-dynamic-python-version-from-pypi
Jan 6, 2026
Merged

Docs use dynamic python version from pypi#69
cpaniaguam merged 2 commits intomainfrom
docs-use-dynamic-python-version-from-pypi

Conversation

@cpaniaguam
Copy link
Collaborator

This pull request updates the documentation and project metadata to more accurately reflect supported Python versions.

Documentation update:

  • Updated the Python version badge in README.md to dynamically show all supported versions via PyPI, instead of listing specific versions.

Project metadata:

  • Added explicit Python version classifiers (3, 3.11, 3.12, 3.13) to pyproject.toml for clearer compatibility information.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR modernizes the Python version documentation by replacing a static badge with a dynamic PyPI-sourced badge and adding explicit version classifiers to project metadata.

  • Updated README.md to use a dynamic shields.io badge that automatically reflects supported Python versions from PyPI
  • Added Python version classifiers (3, 3.11, 3.12, 3.13) to pyproject.toml, consistent with the existing requires-python = ">3.10, <3.14" constraint

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Replaced static Python version badge with dynamic PyPI-based badge
pyproject.toml Added explicit Python version classifiers for 3.11, 3.12, and 3.13

I've completed my review of this pull request. The changes are well-implemented and consistent:

  1. README.md: The new badge URL https://img.shields.io/pypi/pyversions/lanfactory is the correct format for shields.io to dynamically display Python versions from PyPI metadata.

  2. pyproject.toml: The added classifiers (Python 3, 3.11, 3.12, 3.13) correctly match the existing requires-python = ">3.10, <3.14" constraint, which supports Python 3.11, 3.12, and 3.13.

The changes align perfectly with the PR description and achieve the stated goal of making the Python version documentation more maintainable by sourcing it from PyPI rather than requiring manual updates.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Jan 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@AlexanderFengler
Copy link
Member

Thanks @cpaniaguam this is great. Failed on that before.
Could we apply the same solution across all three packages?

Copy link
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@cpaniaguam
Copy link
Collaborator Author

Thanks @cpaniaguam this is great. Failed on that before. Could we apply the same solution across all three packages?

@AlexanderFengler there is a corresponding PR for ssms and hssm already has this.

@cpaniaguam cpaniaguam merged commit 5b40062 into main Jan 6, 2026
13 checks passed
@cpaniaguam cpaniaguam deleted the docs-use-dynamic-python-version-from-pypi branch January 6, 2026 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants